home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 034a / pchat2b4.zip / PROCHAT.DOC < prev    next >
Text File  |  1991-09-08  |  13KB  |  243 lines
  1.                 ProChat - The Ultimate Chat Door for PCBoard 14.x
  2.                        A ProKit based door by Matt Messier
  3.                          (c) Copyright 1990 Matt Messier
  4.  
  5. ProChat is a full featured chat replacement for PCBoard's internal chat.
  6. It allows users to page others while in PCBoard, and also while in ProChat.
  7. It also has many features not found in PCBoard's chat.
  8.  
  9. Config File
  10. -----------
  11.      Prochat uses the standard prokit door config file format.  The first line
  12. must be the com driver type.  This can be one of the following:
  13.  
  14.    INTERRUPT  - The best, fastest
  15.    BIOS       - if interrupt fails to work
  16.  
  17. Prochat also uses several lines after that.  The format of the config file is
  18. as follows:
  19.  
  20. Line 1 - Com driver type (See above)
  21. Line 2 - Path & name of your usernet.dat file
  22. Line 3 - Path & name of the prochat data file - this will be created by prochat
  23.          the first time it is run.
  24. Line 4 - Path & name of the prochat chat data file - this will also be created
  25.          by prochat the first time it is run.  The format is VERY different
  26.          the format used by PCBoard itself, so do NOT use it in conjunction
  27.          with PCBoard's chat mode!
  28. Line 5 - # Chat channels available for users.  You can have up to 65535 chat
  29.          channels, or none at all.  You will probably want no more than 5
  30.          channels since no system is large enough to make use of every channel.
  31. Line 6 - Path & name of the welcome file to Prochat.  This file is displayed
  32.          after the user chooses his handle.  A 'g' is appended for a graphics
  33.          version if the user is in graphics mode.  PCBoard's @command@ commands
  34.          are also available in the text file.
  35. Line 7 - Flush method to use.  This is a number 1, 2, or 3.  1 is the best &
  36.          fastest.  If this does not work, try 2.  It is slower but should work.
  37.          If ALL else fails, use 3.  This is the slowest method but WILL work
  38.          since it closes and reopens the file when it writes to it.
  39. Line 8 - [REGISTERED VERSIONS ONLY] This is the name of your BBS.  It must be
  40.          typed exactly as you are given when you register the program.
  41. Line 9 - [REGISTERED VERSIONS ONLY] This is your registration number.  It is
  42.          used in conjunction with line 8 to make sure the program is actually
  43.          registered.  Lines 8 and 9 are not necessary if you have not
  44.          registered Prochat.
  45. Line 10- Number of nodes to support.  This should be the highest node number.
  46.          If it is not here, it will default to 9 nodes.  If you have not
  47.          registered ProChat, leave lines 8 and 9 blank and fill this one in.
  48. Line 11- Name and location of the help file.  If this is blank, CHTHELP will
  49.          be used as the default name and expected to be residing in the current
  50.          directory.
  51. Line 12- [2.0ß2] place a "-1" (without quotes) here to allow the use of
  52.          handles.  Anything else will disable handles.  Absence of this line
  53.          will disable handles.
  54. Line 13- [2.0ß2] place a "-1" (without quotes) here to allow the word "SYSOP"
  55.          to be used in users' handles.  Absence of this line will disallow
  56.          users to use the word "SYSOP" in their handles.
  57. Line 14- [2.0ß2] place a "-1" (without quotes) here to allow users to use the
  58.          same handle twice (ie. user on node one has the handle Matt.  If this
  59.          flag is turned on, no one else may use the handle Matt while the
  60.          original Matt is still in ProChat)
  61. Line 15- [2.0ß2] place a "-1" (without quotes) here to allow the word "SYSTEM"
  62.          to be used in users' handles.  Absence of this line will disallow
  63.          users to use the word "SYSTEM" in their handles
  64. Line 16- [2.0ß2] UNUSED.  RESERVED FOR FUTURE VERSIONS
  65. Line 17- [2.0ß2] place a "-1" (without quotes) here to have the users' calling
  66.          location displayed in the PCBoard node scans (/PA and /PC commands).
  67.          This is the same thing as the flag in PCBSetup "Include city field in
  68.          node scan".
  69.  
  70. CHTSETUP - Configuration Utility For ProChat 2.0ß2+
  71. ---------------------------------------------------
  72.      Starting with ProChat v2.0ß2, there is a program called CHTSETUP.EXE in
  73. the distribution ZIP file.  This program is meant to be a MUCH easier way to
  74. edit your configuration file for ProChat.  ProChat's configuration file is
  75. growing rapidly and becoming more and more of a pain to edit with a text
  76. editor.  CHTSETUP is very simple to use.  Simply run it with one command line
  77. parameter.  The command line parameter is the name and location of your ProChat
  78. configuration file.  For example, CHTSETUP PROCHAT.CNF will edit the file
  79. PROCHAT.CNF.  If the configuration file that you specify does not exist, it
  80. will be created for you.  Press ESC to exit editing.  It will save your changes
  81. automatically.  Use the up and down arrows, enter, tab, and shift-tab to move
  82. around the screen.
  83.  
  84. DOORS.DAT Modification
  85. ----------------------
  86.      Be sure to modify your PCBoard DOORS.DAT file to reflect the new door.
  87. For example, adding "CB,,10" to your file would allow users in a 14.5 environ-
  88. ment to have access to a new "CB" command at the main menu.  With modification
  89. to your PCBTEXT file(s), ProChat will seem almost transparent to your users.
  90. Users can be paged while on the main board, etc, just like PCB Chat.  
  91. Note: Please do not raise the CHAT security in PCBSetup. This will disable the
  92. "Paging" feature of ProChat.  PCBText modifications (See below) will inform
  93. the users of the new facility.
  94.  
  95. Batch File
  96. ----------
  97.      ProChat also uses the same batch file as most prokit doors.  Your batch
  98. file should look something like this:
  99.  
  100. @echo off
  101. c:
  102. cd\prochat
  103. prochat chat.cnf c:\pcb
  104. cd\pcb
  105. if exist event.bat event
  106. board
  107.  
  108. Notice line 6.  This line is crucial if you have events that run.  ProChat will
  109. recognize the fact that a scheduled event should run and will run it if it is
  110. necessary after the caller logs off.  Failure to add this line and if an event
  111. is scheduled to run, the event will NOT run.
  112.  
  113. Modifications to your PCBTEXT file(s)
  114. -------------------------------------
  115.      Once you get ProChat up and running, it is recommended that you make 
  116. some changes to your PCBTEXT files(s).  These changes will make the door
  117. appear to be a normal part of PCBoard. Please customize these suggestions
  118. for your board, here are some sample modifications:
  119.  
  120.  Record#   Text
  121.    122     Please type Q to quit back to the main board.
  122.    156     Please hit <ENTER> and type  CB  to enter CHAT.
  123.    225     wants you in ProChat/CB, @FIRST@.
  124.    226     At the Command line, type CB to chat with user
  125.    227     To Chat, type CB at the main command line. Please Press (ENTER)
  126.    228     To Chat, type CB at the main command line. Please Press (ENTER)
  127.    231     THE PCB Chat facility is no longer used-
  128.    234     Please enter (q) and then type CB to chat. Thanks!
  129.    248     PCBoard CHAT has been replaced with CB.
  130.    304     Available for CB
  131.    307     CB Request Sent
  132.    311     Chatting in CB
  133.  
  134.   
  135. Handles
  136. -------
  137.      When a user is in chat, they are allowed to use handles.  When the door is
  138. first opened it displays the copyright notice, and asks the user for a handle.
  139. The default is the user's first name.  Once in chat, the user can change his or
  140. her handle with the "/HA" command.  No two users can have the same handle in
  141. chat.  Prochat will not allow it.  The word "SYSOP" also cannot be anywhere in
  142. the handle.  This was done so users could not pretend to be the sysop.
  143.  
  144. Who is on
  145. ---------
  146.      There are 3 different methods of determining who is on the system.  First,
  147. the user can type /PC for a PCBoard style node scan.  This will display who is
  148. on the system and what they are doing, just like PCBoard's WHO command.  The
  149. caller can also type /NO to see who is in Prochat.  This will tell the user
  150. what channel everybody is chatting on, who everyone is (full name & handle),
  151. baud rate connected at.  Finally, the user can type /FR to see who is chatting
  152. on the same channel is him/her.
  153.  
  154. Paging users
  155. ------------
  156.      The caller can type /PA to page a user.  The PCBoard style node scan is
  157. displayed to the user, and then the node number to page is asked.  ProChat
  158. will automatically determine which method to use to page the user.  If the user
  159. is not in Prochat, then the user will be paged via the normal PCBoard method.
  160. If the user is in Prochat, then the user will paged within ProChat.  If the
  161. user is paged in PCBoard, the user can only be paged once until the request is
  162. received.  If the user is paged in ProChat, the user can be paged any number of
  163. times.
  164.  
  165. Private Messaging
  166. -----------------
  167.      Users can also send a private message to another user on any channel.
  168. This is achieved by typing "/SE".  The node number to send the message to will
  169. be asked of the user, and then the caller will be asked to type the message.
  170. This only works when a both users involved are in Prochat.  The private message
  171. will go to any chat channel or squelch value.  No matter where the receiving
  172. party is in Prochat, the message will be received.
  173.  
  174. Private Chat
  175. ------------
  176.      Users can also have a private chat between two or more people.  This is 
  177. accomplished by typing "/SQ" and choosing a "password".  The password can be
  178. up to 12 characters in length and case is not important.  Pressing enter with
  179. no input will return the user to public chat.  If the user is in private chat,
  180. referred to as SQUELCH, and pages a user that is in Prochat, the user will be
  181. told what squelch value to use.
  182.  
  183. Channels
  184. --------
  185.      This can be turned off in the config file by setting the number of chat
  186. channels to zero (0).  Users can move around the various channels by typing
  187. "/CH" to change channels.  When a user in prochat is paged, the chat channel
  188. is also given to the user.
  189.  
  190. Monitoring
  191. ----------
  192.      Users also have the option of choosing up to 5 channels to monitor in
  193. addition to the channel he or she is chatting on.  If any text is sent on a
  194. monitored channel with the same squelch value, the message will be displayed
  195. with the channel number in front of who the message is from.  The caller can
  196. select the channels to monitor by typing "/MO" and entering the channel numbers
  197. to toggle.
  198.  
  199.      If the caller is chatting on channel 2, monitoring channels 1 and 3, and
  200. switches to channel 3, channel 3 will be removed from the monitor list because
  201. the user is chatting on that channel.  The old channel that the user was
  202. chatting on will NOT be added to the monitor list, however.
  203.  
  204. Chatting
  205. --------
  206.      Prochat is basically the same as PCBoard chat.  It displays the user's
  207. handle, and then the user is allowed to type his/her message.  Word wrap is
  208. also used so enter is not necessary to type a message longer than 56
  209. characters.  Pressing enter will send the text on the current line, however.
  210.  
  211.      There are two editing keys available to the caller in chat.  Pressing
  212. CTRL-A will delete the word in back of the cursor.  In other words, pressing
  213. CTRL-A will delete the last word typed.  Also, pressing CTRL-X will delete
  214. the line currently being typed.
  215.  
  216.      If the caller tries to send a message and nobody is listening to the user
  217. on the current channel/squelch value, the caller will be told that nobody is
  218. chatting on the same channel, and the text will not be saved to the chat data
  219. file.
  220.  
  221. Registration
  222. ------------
  223.      Registration for Prochat is a mere $20.  If you are running more than 5
  224. nodes, please contact Matt Messier for pricing information.  Charging the same
  225. amount for all sizes is no fair to those with smaller systems since they're
  226. paying for the bigger systems.  To register Prochat, send a check to "Matt
  227. Messier" at the following address:
  228.  
  229.      Prochat Registration
  230.      c/o Matt Messier
  231.      3 Loring Drive
  232.      Lincoln, RI   02865-1623
  233.  
  234. Registering Prochat will eliminate the log-in message saying the door is not
  235. registered and will tell the user who the door is registered to.  When you
  236. register the door, your registration number will be sent to you within a week
  237. of receiving your check.  Please also tell us what the name of your BBS is and
  238. how you would like it displayed on your system.  Upper/Lower case IS important!
  239. Thank you for your support!
  240.  
  241. Also, if you should need online support - or have suggestions, I (Matt Messier)
  242. can be reached at 401-726-3859 (Data).
  243.